<!-- HTML header for doxygen 1.8.18-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.18"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Ipopt: Ipopt::IpoptAdditionalCq Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  $(document).ready(function() { init_search(); });
/* @license-end */
</script>
<script type="text/x-mathjax-config">
  MathJax.Hub.Config({
    extensions: ["tex2jax.js"],
    jax: ["input/TeX","output/HTML-CSS"],
});
</script>
<script type="text/javascript" async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.js"></script>
<link href="stylesheet.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 40px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">Ipopt Documentation
   &#160;<!--span id="projectnumber">3.14.12</span-->
   </div>
  </td>
   <td>        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
</td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.18 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('classIpopt_1_1IpoptAdditionalCq.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="classIpopt_1_1IpoptAdditionalCq-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">Ipopt::IpoptAdditionalCq Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div>  </div>
</div><!--header-->
<div class="contents">

<p>Base class for additional calculated quantities that is special to a particular type of algorithm, such as the CG penalty function, or using iterative linear solvers.  
 <a href="classIpopt_1_1IpoptAdditionalCq.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="IpIpoptCalculatedQuantities_8hpp_source.html">IpIpoptCalculatedQuantities.hpp</a>&gt;</code></p>
<div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
  <img id="dynsection-0-trigger" src="closed.png" alt="+"/> Inheritance diagram for Ipopt::IpoptAdditionalCq:</div>
<div id="dynsection-0-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-0-content" class="dyncontent" style="display:none;">
<div class="center"><img src="classIpopt_1_1IpoptAdditionalCq__inherit__graph.png" border="0" usemap="#Ipopt_1_1IpoptAdditionalCq_inherit__map" alt="Inheritance graph"/></div>
<map name="Ipopt_1_1IpoptAdditionalCq_inherit__map" id="Ipopt_1_1IpoptAdditionalCq_inherit__map">
<area shape="rect" title="Base class for additional calculated quantities that is special to a particular type of algorithm,..." alt="" coords="71,80,250,107"/>
<area shape="rect" href="classIpopt_1_1CGPenaltyCq.html" title="Class for all Chen&#45;Goldfarb penalty method specific calculated quantities." alt="" coords="5,155,153,181"/>
<area shape="rect" href="classIpopt_1_1InexactCq.html" title="Class for all Chen&#45;Goldfarb penalty method specific calculated quantities." alt="" coords="178,155,306,181"/>
<area shape="rect" href="classIpopt_1_1ReferencedObject.html" title="Storing the reference count of all the smart pointers that currently reference it." alt="" coords="71,5,250,32"/>
</map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a92d2fa94b2543cfec8a8d9eda8af78e5"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classIpopt_1_1IpoptAdditionalCq.html#a92d2fa94b2543cfec8a8d9eda8af78e5">Initialize</a> (const <a class="el" href="classIpopt_1_1Journalist.html">Journalist</a> &amp;jnlst, const <a class="el" href="classIpopt_1_1OptionsList.html">OptionsList</a> &amp;options, const std::string &amp;prefix)=0</td></tr>
<tr class="memdesc:a92d2fa94b2543cfec8a8d9eda8af78e5"><td class="mdescLeft">&#160;</td><td class="mdescRight">This method is called to initialize the global algorithmic parameters.  <a href="classIpopt_1_1IpoptAdditionalCq.html#a92d2fa94b2543cfec8a8d9eda8af78e5">More...</a><br /></td></tr>
<tr class="separator:a92d2fa94b2543cfec8a8d9eda8af78e5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr><td colspan="2"><div class="groupHeader">Constructors/Destructors</div></td></tr>
<tr class="memitem:a03e0d8c68bb88c98ec23d420518d5fe0"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classIpopt_1_1IpoptAdditionalCq.html#a03e0d8c68bb88c98ec23d420518d5fe0">IpoptAdditionalCq</a> ()</td></tr>
<tr class="memdesc:a03e0d8c68bb88c98ec23d420518d5fe0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default Constructor.  <a href="classIpopt_1_1IpoptAdditionalCq.html#a03e0d8c68bb88c98ec23d420518d5fe0">More...</a><br /></td></tr>
<tr class="separator:a03e0d8c68bb88c98ec23d420518d5fe0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad000feb1820f3809156312d6dfdac97c"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classIpopt_1_1IpoptAdditionalCq.html#ad000feb1820f3809156312d6dfdac97c">~IpoptAdditionalCq</a> ()</td></tr>
<tr class="memdesc:ad000feb1820f3809156312d6dfdac97c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor.  <a href="classIpopt_1_1IpoptAdditionalCq.html#ad000feb1820f3809156312d6dfdac97c">More...</a><br /></td></tr>
<tr class="separator:ad000feb1820f3809156312d6dfdac97c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_classIpopt_1_1ReferencedObject"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classIpopt_1_1ReferencedObject')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classIpopt_1_1ReferencedObject.html">Ipopt::ReferencedObject</a></td></tr>
<tr class="memitem:a5c0f2208e3ead22bf7c5179381ed8203 inherit pub_methods_classIpopt_1_1ReferencedObject"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classIpopt_1_1ReferencedObject.html#a5c0f2208e3ead22bf7c5179381ed8203">ReferencedObject</a> ()</td></tr>
<tr class="separator:a5c0f2208e3ead22bf7c5179381ed8203 inherit pub_methods_classIpopt_1_1ReferencedObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adbbf3aa5307da62ab8224ba599d4bd7a inherit pub_methods_classIpopt_1_1ReferencedObject"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classIpopt_1_1ReferencedObject.html#adbbf3aa5307da62ab8224ba599d4bd7a">~ReferencedObject</a> ()</td></tr>
<tr class="separator:adbbf3aa5307da62ab8224ba599d4bd7a inherit pub_methods_classIpopt_1_1ReferencedObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aac517534e10e36c946aeefc6fe337777 inherit pub_methods_classIpopt_1_1ReferencedObject"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceIpopt.html#a5a4a27f325033a0e5d85a4ebc4038b57">Index</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classIpopt_1_1ReferencedObject.html#aac517534e10e36c946aeefc6fe337777">ReferenceCount</a> () const</td></tr>
<tr class="separator:aac517534e10e36c946aeefc6fe337777 inherit pub_methods_classIpopt_1_1ReferencedObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa69ecb0f026bd741e2fa84c31d4ec332 inherit pub_methods_classIpopt_1_1ReferencedObject"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classIpopt_1_1ReferencedObject.html#aa69ecb0f026bd741e2fa84c31d4ec332">AddRef</a> (const <a class="el" href="classIpopt_1_1Referencer.html">Referencer</a> *referencer) const</td></tr>
<tr class="separator:aa69ecb0f026bd741e2fa84c31d4ec332 inherit pub_methods_classIpopt_1_1ReferencedObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae6c952e7d1a63080dc8f121c008944fc inherit pub_methods_classIpopt_1_1ReferencedObject"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classIpopt_1_1ReferencedObject.html#ae6c952e7d1a63080dc8f121c008944fc">ReleaseRef</a> (const <a class="el" href="classIpopt_1_1Referencer.html">Referencer</a> *referencer) const</td></tr>
<tr class="separator:ae6c952e7d1a63080dc8f121c008944fc inherit pub_methods_classIpopt_1_1ReferencedObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-methods"></a>
Private Member Functions</h2></td></tr>
<tr><td colspan="2"><div class="groupHeader">Default Compiler Generated Methods</div></td></tr>
<tr><td colspan="2"><div class="groupText"><p>(Hidden to avoid implicit creation/calling).</p>
<p>These methods are not implemented and we do not want the compiler to implement them for us, so we declare them private and do not define them. This ensures that they will not be implicitly created/called. </p>
</div></td></tr>
<tr class="memitem:ac1ab46fdfb27185a509aa3b765a77b1b"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classIpopt_1_1IpoptAdditionalCq.html#ac1ab46fdfb27185a509aa3b765a77b1b">IpoptAdditionalCq</a> (const <a class="el" href="classIpopt_1_1IpoptAdditionalCq.html">IpoptAdditionalCq</a> &amp;)</td></tr>
<tr class="memdesc:ac1ab46fdfb27185a509aa3b765a77b1b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Copy Constructor.  <a href="classIpopt_1_1IpoptAdditionalCq.html#ac1ab46fdfb27185a509aa3b765a77b1b">More...</a><br /></td></tr>
<tr class="separator:ac1ab46fdfb27185a509aa3b765a77b1b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5bb3ba98d0f862956e9e61299383b5bf"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classIpopt_1_1IpoptAdditionalCq.html#a5bb3ba98d0f862956e9e61299383b5bf">operator=</a> (const <a class="el" href="classIpopt_1_1IpoptAdditionalCq.html">IpoptAdditionalCq</a> &amp;)</td></tr>
<tr class="memdesc:a5bb3ba98d0f862956e9e61299383b5bf"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default Assignment Operator.  <a href="classIpopt_1_1IpoptAdditionalCq.html#a5bb3ba98d0f862956e9e61299383b5bf">More...</a><br /></td></tr>
<tr class="separator:a5bb3ba98d0f862956e9e61299383b5bf"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Base class for additional calculated quantities that is special to a particular type of algorithm, such as the CG penalty function, or using iterative linear solvers. </p>
<p>The regular <a class="el" href="classIpopt_1_1IpoptCalculatedQuantities.html" title="Class for all IPOPT specific calculated quantities.">IpoptCalculatedQuantities</a> object should be given a derivation of this base class when it is created. </p>

<p class="definition">Definition at line <a class="el" href="IpIpoptCalculatedQuantities_8hpp_source.html#l00039">39</a> of file <a class="el" href="IpIpoptCalculatedQuantities_8hpp_source.html">IpIpoptCalculatedQuantities.hpp</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a03e0d8c68bb88c98ec23d420518d5fe0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a03e0d8c68bb88c98ec23d420518d5fe0">&#9670;&nbsp;</a></span>IpoptAdditionalCq() <span class="overload">[1/2]</span></h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">Ipopt::IpoptAdditionalCq::IpoptAdditionalCq </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Default Constructor. </p>

<p class="definition">Definition at line <a class="el" href="IpIpoptCalculatedQuantities_8hpp_source.html#l00045">45</a> of file <a class="el" href="IpIpoptCalculatedQuantities_8hpp_source.html">IpIpoptCalculatedQuantities.hpp</a>.</p>

</div>
</div>
<a id="ad000feb1820f3809156312d6dfdac97c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad000feb1820f3809156312d6dfdac97c">&#9670;&nbsp;</a></span>~IpoptAdditionalCq()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual Ipopt::IpoptAdditionalCq::~IpoptAdditionalCq </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Destructor. </p>

<p class="definition">Definition at line <a class="el" href="IpIpoptCalculatedQuantities_8hpp_source.html#l00049">49</a> of file <a class="el" href="IpIpoptCalculatedQuantities_8hpp_source.html">IpIpoptCalculatedQuantities.hpp</a>.</p>

</div>
</div>
<a id="ac1ab46fdfb27185a509aa3b765a77b1b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac1ab46fdfb27185a509aa3b765a77b1b">&#9670;&nbsp;</a></span>IpoptAdditionalCq() <span class="overload">[2/2]</span></h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">Ipopt::IpoptAdditionalCq::IpoptAdditionalCq </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classIpopt_1_1IpoptAdditionalCq.html">IpoptAdditionalCq</a> &amp;&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Copy Constructor. </p>

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a92d2fa94b2543cfec8a8d9eda8af78e5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a92d2fa94b2543cfec8a8d9eda8af78e5">&#9670;&nbsp;</a></span>Initialize()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual bool Ipopt::IpoptAdditionalCq::Initialize </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classIpopt_1_1Journalist.html">Journalist</a> &amp;&#160;</td>
          <td class="paramname"><em>jnlst</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="classIpopt_1_1OptionsList.html">OptionsList</a> &amp;&#160;</td>
          <td class="paramname"><em>options</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const std::string &amp;&#160;</td>
          <td class="paramname"><em>prefix</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>This method is called to initialize the global algorithmic parameters. </p>
<p>The parameters are taken from the <a class="el" href="classIpopt_1_1OptionsList.html" title="This class stores a list of user set options.">OptionsList</a> object. </p>

<p>Implemented in <a class="el" href="classIpopt_1_1InexactCq.html#abb019946ccd69e74f3a93b4c28b5a1fb">Ipopt::InexactCq</a>, and <a class="el" href="classIpopt_1_1CGPenaltyCq.html#af3d1cc5d7d10771a97ca7e31d0ad7abb">Ipopt::CGPenaltyCq</a>.</p>

</div>
</div>
<a id="a5bb3ba98d0f862956e9e61299383b5bf"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5bb3ba98d0f862956e9e61299383b5bf">&#9670;&nbsp;</a></span>operator=()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void Ipopt::IpoptAdditionalCq::operator= </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classIpopt_1_1IpoptAdditionalCq.html">IpoptAdditionalCq</a> &amp;&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Default Assignment Operator. </p>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>src/Algorithm/<a class="el" href="IpIpoptCalculatedQuantities_8hpp_source.html">IpIpoptCalculatedQuantities.hpp</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
</body>
</html>
